Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@npmcli/agent
Advanced tools
@npmcli/agent is a Node.js package that helps in managing HTTP user agents. It provides utilities to create and manage user agent strings, which can be useful for making HTTP requests with specific user agent headers.
Create a User Agent
This feature allows you to create a user agent string based on the current environment. The `getUserAgent` function generates a user agent string that can be used in HTTP requests.
const { getUserAgent } = require('@npmcli/agent');
const userAgent = getUserAgent();
console.log(userAgent);
Custom User Agent
This feature allows you to create a custom user agent string by providing specific details like the name and version of your application. The `getUserAgent` function accepts an object with `name` and `version` properties to customize the user agent string.
const { getUserAgent } = require('@npmcli/agent');
const userAgent = getUserAgent({ name: 'my-app', version: '1.0.0' });
console.log(userAgent);
The `useragent` package is a comprehensive library for parsing and generating user agent strings. It provides more detailed parsing capabilities compared to @npmcli/agent, making it suitable for applications that need to analyze user agent strings in depth.
The `ua-parser-js` package is a JavaScript library for parsing user agent strings. It offers extensive support for detecting browser, engine, OS, and device information. Compared to @npmcli/agent, it focuses more on parsing and less on generating user agent strings.
A pair of Agent implementations for nodejs that provide consistent keep-alives, granular timeouts, dns caching, and proxy support.
const { getAgent, HttpAgent } = require('@npmcli/agent')
const fetch = require('minipass-fetch')
const main = async () => {
// if you know what agent you need, you can create one directly
const agent = new HttpAgent(agentOptions)
// or you can use the getAgent helper, it will determine and create an Agent
// instance for you as well as reuse that agent for new requests as appropriate
const agent = getAgent('https://registry.npmjs.org/npm', agentOptions)
// minipass-fetch is just an example, this will work for any http client that
// supports node's Agents
const res = await fetch('https://registry.npmjs.org/npm', { agent })
}
main()
All options supported by the node Agent implementations are supported here, see the docs for those.
Options that have been added by this module include:
family
: what tcp family to use, can be 4
for IPv4, 6
for IPv6 or 0
for both.proxy
: a URL to a supported proxy, currently supports HTTP CONNECT
based http/https proxies as well as socks4 and 5.dns
: configuration for the built-in dns cache
ttl
: how long (in milliseconds) to keep cached dns entries, defaults to 5 * 60 * 100 (5 minutes)
lookup
: optional function to override how dns lookups are performed, defaults to require('dns').lookup
timeouts
: a set of granular timeouts, all default to 0
connection
: time between initiating connection and actually connectingidle
: time between data packets (if a top level timeout
is provided, it will be copied here)response
: time between sending a request and receiving a responsetransfer
: time between starting to receive a request and consuming the response fullyFAQs
the http/https agent used by the npm cli
The npm package @npmcli/agent receives a total of 5,115,628 weekly downloads. As such, @npmcli/agent popularity was classified as popular.
We found that @npmcli/agent demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.